Skip to main content

Update API from Data-Format

This feature allows you to generate an Update API endpoint based on a selected data format. The Update API is used to update existing data objects by their unique identifiers.

Description​

The "Update API from Data-Format" option simplifies the process of creating a secure and functional API for updating data. By selecting a predefined data format, you can quickly generate an Update API that is ready to use or customize further.

Step-by-Step Guide​

Follow these steps to create an Update API from a data format:

  1. Go to the "API" Section
    Navigate to the API section in your application or platform.

  2. Choose "Select New API"
    Click on the option labeled "Select New API" to start creating a new API.

  3. Select "Update API from Data-Format"
    From the available options, choose "Update API from Data-Format".

  4. Select the Data Format
    Pick the available data format that you want to use for generating the Update API. This format defines the structure of the data to be updated.

  5. Click "Create API"
    Once the data format is selected, click the "Create API" button to generate the Update API.

  6. View and Use the API
    After creation, the generated Update API will be displayed. You can:

    • Test the endpoint.
    • Integrate it into your application.
    • Modify it as needed.

Key Features​

  • Automatic API Generation: Quickly create an Update API without manual coding.
  • ID-Based Updates: The API uses the unique identifier of an object to update it.
  • Secure and Standardized: The API follows industry best practices for security and design.
  • Customizable: Modify the generated API to suit your specific needs.
  • Time-Saving: Generate a functional Update API in seconds with minimal effort.